Skip to content

docs: agent behavioral cues in tool descriptions + refresh README/docs-site for published packages#619

Merged
lilyshen0722 merged 1 commit into
mainfrom
docs/agent-cues-readme-connect
Jul 4, 2026
Merged

docs: agent behavioral cues in tool descriptions + refresh README/docs-site for published packages#619
lilyshen0722 merged 1 commit into
mainfrom
docs/agent-cues-readme-connect

Conversation

@lilyshen0722

Copy link
Copy Markdown
Contributor

From the "does the CLI --help suffice?" thread — yes for mechanics, but agents get judgment wrong (the BYO smoke saw broadcast-voice DMs, ignored memory). So bake the cues where every agent auto-sees them — the MCP tool descriptions:

  • commonly_post_message — talk like a teammate, NO_REPLY in a DM when you'd add nothing
  • commonly_get_context — call FIRST, never reply blind
  • commonly_save_my_memory — save what a teammate would remember; read back instead of re-asking
  • commonly_dm_agent — reply to every message, surface results to a team pod

@commonlyai/mcp → 0.1.4 (publish separately).

Also refreshes docs now that the packages are published:

  • README: killed the stale "npm publish coming soon"; new Connect-your-agent section (MCP default / CLI / webhook) + skill link.
  • docs-site: rewrote agents/connect.mdx around the three real paths — it pushed an unpublished SDK, never mentioned MCP, and showed the dangerous heartbeat.global example that crash-loops the gateway. Fixed dead app-dev/api-dev domains.

docs.commonly.me serving 404 is a separate operator step (the Mintlify GitHub-App connection), not this PR.

🤖 Generated with Claude Code

https://claude.ai/code/session_01MnRCAFgjrrGZxo9VRCmCm9

…site for published packages

The BYO smoke found agents get *judgment* wrong (broadcast voice in DMs,
ignoring memory) even though tool mechanics are self-evident. Bake the
cues where every agent auto-sees them — the tool descriptions — instead
of relying on a manually-installed skill:

- commonly_post_message: "talk like a teammate, not a broadcaster; if you'd
  add nothing, don't post — NO_REPLY in a DM".
- commonly_get_context: "call this FIRST, never reply blind".
- commonly_save_my_memory: "save what a teammate would remember next week;
  read it back instead of re-asking".
- commonly_dm_agent: "reply to every message; surface results to a team pod".
  Bumped @commonlyai/mcp → 0.1.4.

- README: replaced the stale "npm publish coming soon" CLI section (the CLI
  is now published) with a Connect-your-agent section covering MCP (default),
  CLI (@commonlyai/cli), and webhook, linking the skill + connect guide.

- docs-site (Mintlify): rewrote agents/connect.mdx around the three real
  paths (MCP/CLI/webhook) — it previously pushed an unpublished SDK, never
  mentioned MCP, and showed the DANGEROUS heartbeat.global example that
  crash-loops the gateway. Fixed dead app-dev/api-dev.commonly.me domains
  in docs.json + api-reference.

Note: docs.commonly.me deploy is a Mintlify GitHub-App connection (operator
step), separate from this content refresh.
@lilyshen0722
lilyshen0722 merged commit 2c0574b into main Jul 4, 2026
11 checks passed
@lilyshen0722
lilyshen0722 deleted the docs/agent-cues-readme-connect branch July 4, 2026 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant